home *** CD-ROM | disk | FTP | other *** search
/ HPAVC / HPAVC CD-ROM.iso / pc / ELYVER10.ZIP / MIKXMAS.ZIP / docs / mplayer.doc < prev    next >
Encoding:
Text File  |  1995-11-20  |  2.6 KB  |  134 lines
  1. ┌──────────────────────────────┐
  2. │MPLAYER.C Module Documentation│
  3. └──────────────────────────────┘
  4.  
  5. Date last modified: October 20, 1995
  6.  
  7. ════════════════════════════════════════════════════════════════════════════════
  8.  
  9. MPLAYER public variables:
  10.  
  11. // read only (not really, but it's not wise to change 'em):
  12.  
  13. AUDTMP mp_audio[32];    // the 32 temporary channels
  14. UBYTE  mp_bpm;        // beats-per-minute speed
  15. UWORD  mp_patpos;    // current row number
  16. int    mp_sngpos;    // current song position
  17. UWORD  mp_sngspd;    // current songspeed
  18.  
  19. // read/write variables:
  20.  
  21. BOOL  mp_loop       // enable/disable looping
  22. BOOL  mp_panning    // enable/disable panning
  23. BOOL  mp_extspd        // enable/disable extended (bpm) speed 
  24. UBYTE mp_volume         // song volume (0-100)
  25.  
  26. ════════════════════════════════════════════════════════════════════════════════
  27.  
  28. void MP_Init(UNIMOD *m)
  29. =======================
  30.  
  31. Input parms:
  32.  
  33.     m       Pointer to a UNIMOD module (which was loaded with MLOADER.C)
  34.  
  35.  
  36. Returns:
  37.  
  38.     -
  39.  
  40. Description:
  41.  
  42. Initializes the module player to start playing this module the next time 
  43. MP_HandleTick() is called.
  44.  
  45. ════════════════════════════════════════════════════════════════════════════════
  46.  
  47. void MP_HandleTick(void)
  48. =======================
  49.  
  50. Input parms:
  51.  
  52.     -
  53.  
  54. Returns:
  55.  
  56.     -
  57.  
  58. Description:
  59.  
  60. You have to call this routine at the current BPM rate (mp_bpm) to play the 
  61. song you initialized with MP_Init().
  62.  
  63. ════════════════════════════════════════════════════════════════════════════════
  64.  
  65. BOOL MP_Ready(void)
  66. ===================
  67.  
  68. Input parms:
  69.  
  70.     -
  71.  
  72. Returns:
  73.  
  74.     True if the song is finished, FALSE if not.
  75.  
  76. Description:
  77.  
  78. Use this routine to check if a module is done playing. This is only useful if 
  79. you set the variable mp_loop to 0, so a song won't restart when it's done.
  80.  
  81. ════════════════════════════════════════════════════════════════════════════════
  82.  
  83. void MP_PrevPosition(void)
  84. ==========================
  85.  
  86. Input parms:
  87.  
  88.     -
  89.  
  90. Returns:
  91.  
  92.     -
  93.  
  94. Description:
  95.  
  96. skips a song to the previous pattern.
  97.  
  98. ════════════════════════════════════════════════════════════════════════════════
  99.  
  100. void MP_NextPosition(void)
  101. ==========================
  102.  
  103. Input parms:
  104.  
  105.     -
  106.  
  107. Returns:
  108.  
  109.     -
  110.  
  111. Description:
  112.  
  113. skips a song to the next pattern.
  114.  
  115. ════════════════════════════════════════════════════════════════════════════════
  116.  
  117. void MP_SetPosition(UWORD pos)
  118. ==============================
  119.  
  120. Input parms:
  121.  
  122.         pos     Song position to jump to
  123.  
  124.  
  125. Returns:
  126.  
  127.     -
  128.  
  129. Description:
  130.  
  131. skips a song to the specified position.
  132.  
  133. ════════════════════════════════════════════════════════════════════════════════
  134.